Documentación de Sales

NAV Navigation

SalesApi v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

Email: Iberinform Web: Iberinform

Authentication

  • API Key (ClientSecretHeader)

    • Parameter Name: X-IBM-Client-Secret, in: header. Unique token directly related to the client contract
  • API Key (APIKeyHeader)

    • Parameter Name: X-IBM-Client-Id, in: header.

Default

get__sales_{organisationID}

Code samples

URL obj = new URL("https://$(catalog.host)/modules/sales/{organisationID}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();

con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(

 new InputStreamReader(con.getInputStream()));

String inputLine;

StringBuffer response = new StringBuffer();

while ((inputLine = in.readLine()) != null) {

 response.append(inputLine);

}

in.close();

System.out.println(response.toString());




const headers = {

 'Accept':'application/json',

 'X-IBM-Client-Id':'API_KEY',

 'X-IBM-Client-Secret':'API_KEY'

};


fetch('https://$(catalog.host)/modules/sales/{organisationID}',

{

 method: 'GET',


 headers: headers

})

.then(function(res) {

 return res.json();

}).then(function(body) {

 console.log(body);

});


GET https://$(catalog.host)/modules/sales/{organisationID} HTTP/1.1


Accept: application/json


 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY',

);


$client = new \GuzzleHttp\Client();


// Define array of request body.

$request_body = array();


try {

 $response = $client->request('GET','https://$(catalog.host)/modules/sales/{organisationID}', array(

 'headers' => $headers,

 'json' => $request_body,

 )

 );

 print_r($response->getBody()->getContents());

 }

 catch (\GuzzleHttp\Exception\BadResponseException $e) {

 // handle exception or api errors.

 print_r($e->getMessage());

 }


 // ...


import requests

headers = {

 'Accept': 'application/json',

 'X-IBM-Client-Id': 'API_KEY',

 'X-IBM-Client-Secret': 'API_KEY'

}


r = requests.get('https://$(catalog.host)/modules/sales/{organisationID}', headers = headers)


print(r.json())


require 'rest-client'

require 'json'


headers = {

 'Accept' => 'application/json',

 'X-IBM-Client-Id' => 'API_KEY',

 'X-IBM-Client-Secret' => 'API_KEY'

}


result = RestClient.get 'https://$(catalog.host)/modules/sales/{organisationID}',

 params: {

 }, headers: headers


p JSON.parse(result)


# You can also use wget

curl -X GET https://$(catalog.host)/modules/sales/{organisationID} \

 -H 'Accept: application/json' \

 -H 'X-IBM-Client-Id: API_KEY' \

 -H 'X-IBM-Client-Secret: API_KEY'



GET /sales/{organisationID}

Parameters

Name In Type Required Description
organisationID path string true identificador de la firma
language query string false Idioma generación

Example responses

200 Response

"{"closeDate":"string","currentYearSales":{"annualSales":{"expectedAnnualSales":"string","indicator":{"code":"string","value":"string"}},"dateFromPartialSales":"string","dateToPartialSales":"string","partialSales":"string"},"documentLink":"string","notAvailable":"string","period":"string","previousYearSales":{"amount":"string","valor":"string","year":"string"},"salesAssociatedCompanies":"string","salesTrend":{"code":"string","value":"string"},"units":{"code":"string","value":"string"},"year":"string"}"


Responses

Status Meaning Description Schema
200 OK 200 OK SalDetail
401 Unauthorized Unauthorized ErrorDetail
403 Forbidden Forbidden ErrorDetail
404 Not Found Recurso no encontrado ErrorDetail
500 Internal Server Error Internal error ErrorDetail

Schemas

ErrorDetail

"{"code":"string","message":"string","principal":"string","status":0}"



Properties

Name Type Required Restrictions Description
code string false none none
message string false none none
principal string false none none
status number false none none

SalDetail

"{"closeDate":"string","currentYearSales":{"annualSales":{"expectedAnnualSales":"string","indicator":{"code":"string","value":"string"}},"dateFromPartialSales":"string","dateToPartialSales":"string","partialSales":"string"},"documentLink":"string","notAvailable":"string","period":"string","previousYearSales":{"amount":"string","valor":"string","year":"string"},"salesAssociatedCompanies":"string","salesTrend":{"code":"string","value":"string"},"units":{"code":"string","value":"string"},"year":"string"}"



Properties

Name Type Required Restrictions Description
closeDate string false none none
currentYearSales object false none none
  annualSales object false none none
   expectedAnnualSales string false none none
   indicator object false none none
    code string false none none
    value string false none none
  dateFromPartialSales string false none none
  dateToPartialSales string false none none
  partialSales string false none none
documentLink string false none none
notAvailable string false none none
period string false none none
previousYearSales object false none none
  amount string false none none
  valor string false none none
  year string false none none
salesAssociatedCompanies string false none none
salesTrend object false none none
  code string false none none
  value string false none none
units object false none none
  code string false none none
  value string false none none
year string false none none